paginationator
Advanced tools
Paginate an array into pages of items.
Install with npm:
$ npm install --save paginationator
var paginationator = require('paginationator');
Paginate an array with given options and return a Page object containing an array of pages with pagination information.
Params
arr {Array}: Array of items to paginateoptions {Object}: Additional options to control paginationoptions.limit {Number}: Number of items per page (defaults to 10)returns {Object}: paginated pagesExample
var pages = paginationator([1, 2, 3, 4, 5], {limit: 2});
//=> { pages: [
//=> { idx: 0, total: 3, current: 1, items: [1, 2], first: 1, last: 3, next: 2 },
//=> { idx: 1, total: 3, current: 2, items: [3, 4], first: 1, last: 3, prev: 1, next: 3 },
//=> { idx: 2, total: 3, current: 3, items: [5], first: 1, last: 3, prev: 2 }
//=> ]}
Page constructor
Params
page {Object}: optional page object to populate initial values.Example
var page = new Page();
Pages constructor
Params
pages {Array}: Optional array of pages to initialize the pages array.Example
var pages = new Pages();
Add a page to the list.
Params
page {Object}: Plain object or instance of a Pagereturns {Object}: Returns the instance for chainingExample
pages.addPage({items: [1, 2, 3]});
Add an array of pages to the list.
Params
pages {Object}: Array of page objectsreturns {Object}: Returns the instance for chainingExample
pages.addPages([...]);
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
$ npm install -d && npm test
Brian Woodward
Copyright © 2016, Brian Woodward. Released under the MIT license.
This file was generated by verb, v0.9.0, on July 19, 2016.
FAQs
Paginate an array into pages of items.
We found that paginationator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.